Document CLI and UI coexistence for version alignment#519
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This pull request documents the CLI and UI version alignment feature, which ensures that ToolHive UI automatically manages a compatible CLI installation. The documentation explains how the UI manages the CLI, what happens when conflicts occur with standalone CLI installations, and how users can access CLI functionality from the UI.
Changes:
- New guide explaining CLI access from ToolHive UI, including management, settings, and troubleshooting
- Updated CLI install guide with a new section on CLI/UI coexistence and conflict resolution
- Added tips and information boxes across UI and CLI guides to inform users about the relationship between the two
- New FAQ entry clarifying that ToolHive UI and standalone CLI cannot coexist
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.ts | Adds navigation entry for the new CLI access guide in the UI guides section |
| docs/toolhive/guides-ui/cli-access.mdx | New comprehensive guide covering CLI management by ToolHive UI, Settings page details, usage instructions, and troubleshooting |
| docs/toolhive/guides-ui/install.mdx | Adds tip directing advanced users to the CLI access guide after installation |
| docs/toolhive/guides-ui/index.mdx | Updates tip to clarify that UI includes and manages CLI automatically |
| docs/toolhive/guides-cli/install.mdx | Adds new section explaining conflict detection, resolution steps, and debugging override |
| docs/toolhive/guides-cli/index.mdx | Updates tip to inform users that UI automatically manages CLI if installed |
| docs/toolhive/faq.mdx | Adds FAQ entry explaining CLI/UI coexistence behavior and linking to relevant guides |
danbarr
left a comment
danbarr
left a comment
There was a problem hiding this comment.
This is a solid documentation PR for an important feature. The writing quality is good and follows the style guide well.
The main improvements needed are:
- Reduce content duplication - consolidate CLI conflict resolution details in one place
- Reorder cli-access.mdx - show practical usage before technical implementation details
- Simplify repetitive text - avoid verbatim repetition across 4 files
- Clarify FAQ answer - starting with "No" when the answer is actually "Yes, but..." creates confusion
These are primarily information architecture and structure issues rather than writing quality problems. Once addressed, this will be excellent documentation.
See inline comments for specific recommendations with suggested text for each issue.
|
thank you @danbarr I implement your feedback 👍🏼 |
Document how ToolHive UI manages CLI installation, the Settings > CLI page, and troubleshooting for CLI access issues.
Revise tips in UI and CLI index pages to reflect that ToolHive UI manages CLI installation automatically.
Document conflict detection when standalone CLI runs alongside ToolHive UI, including error message and resolution options.
Link to new CLI access guide in the Next steps section.
Explain that ToolHive UI and standalone CLI cannot be used together.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
danbarr
left a comment
danbarr
left a comment
There was a problem hiding this comment.
Thanks, good to merge once the release is out.
2 participants
Description
Document the CLI and UI version alignment feature, explaining how ToolHive UI
manages CLI installation automatically and what happens when a standalone CLI
conflicts with a UI-managed installation.
Changes include:
Settings > CLI page, and troubleshooting
Type of change
Related issues/PRs
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed files